home *** CD-ROM | disk | FTP | other *** search
/ Resource Library: Multimedia / Resource Library: Multimedia.iso / _archive / archivrs / msdos / pak251.exe / pak / PAK.DOC < prev    next >
Text File  |  1990-10-08  |  66KB  |  1,697 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.                                     PAK
  19.  
  20.                         The File Compression Utility
  21.                                 Version 2.51
  22.  
  23.                          Copyright 1988, 1989, 1990
  24.                                      by
  25.                              NoGate Consulting
  26.                                P.O. Box 88115
  27.                         Grand Rapids, MI 49518-0115
  28.                                (616)455-6270
  29.                     BBS: (616)455-5179 (1200-9600+ baud)
  30.                              FAX: (616)455-8491
  31.  
  32.                             ALL RIGHTS RESERVED
  33.  
  34.                                 _______
  35.                            ____|__     |               (Tm)
  36.                         --|       |    |-------------------
  37.                           |   ____|__  |  Association of
  38.                           |  |       |_|  Shareware
  39.                           |__|   o   |    Professionals
  40.                         -----|   |   |---------------------
  41.                              |___|___|    MEMBER
  42.  
  43.  
  44.  
  45.  
  46.    Introduction..............................................1
  47.         Purpose of PAK.......................................1
  48.         Archive Files........................................1
  49.         A Note on the Interface..............................1
  50.         The Shareware Concept................................2
  51.         Registration and Benefits............................2
  52.         Obtaining Updates....................................3
  53.         Limitations..........................................3
  54.         Other NoGate Products................................3
  55.         List of Files........................................3
  56.    The Security Envelope.....................................4
  57.    Creating An Archive.......................................4
  58.         The Add Command......................................4
  59.         The Move Command.....................................5
  60.         The Update Command...................................5
  61.         The Freshen Command..................................5
  62.         Archiving Subdirectories.............................5
  63.    Extracting Files From An Archive..........................6
  64.         The Extract Command..................................6
  65.         The Extract and Remove Command.......................7
  66.         Extracting Files to the Screen or Printer............7
  67.         Extracting files to their original paths.............7
  68.    Managing Archives.........................................8
  69.         Listing Files........................................8
  70.         Deleting Files.......................................8
  71.         Testing files........................................9
  72.    Adding Remarks to Archives................................9
  73.         The /R (remark) option...............................10
  74.         The /H (header remark) option........................10
  75.         The Revise command...................................10
  76.         The Header command...................................10
  77.    Converting Archives for other programs....................10
  78.         Converting to and from ZIP files.....................11
  79.    Self-Extracting Archives..................................12
  80.         Creating self-extracting archives....................12
  81.         Using self-extracting archives.......................12
  82.         Self-extracting to a path............................13
  83.         Converting to self-extracting archives...............13
  84.    Options...................................................13
  85.         Crunch, Squash, and Crush (/C, /S, /CR)..............14
  86.         Zip, Shrink, Bugs (/Z, /ZS, /BUGS)...................14
  87.         Encrypting Files (/G)................................14
  88.         Duplicate Files (/D).................................15
  89.         Make EXE file (/EXE).................................15
  90.         Print in Hex format (/HEX)...........................15
  91.         Including subdirectories (/I)........................16
  92.         Use last date (/L)...................................16
  93.         Moving Files (/M)....................................16
  94.         Pause after each page (/MORE)........................16
  95.         Using the original path (/PATH)......................17
  96.         Use Remarks (/R and /H)..............................17
  97.         Rename archives on convert (/REN)....................17
  98.         Sorting Files (/S)...................................18
  99.  
  100.  
  101.  
  102.         Pack Archives (/P)...................................18
  103.         Check security envelope (/SEC).......................18
  104.         Only use Distill or Implode (/O).....................18
  105.         The Temporary Path (/T)..............................19
  106.         Replacing Existing Files (/W)........................19
  107.    General Syntax............................................20
  108.         Summary of Standard PAK Commands.....................20
  109.    PAKINST (PAK install program).............................21
  110.         Text Configuration Files.............................22
  111.         Comments.............................................22
  112.         Command Definitions..................................22
  113.         Option Definitions...................................23
  114.         Configuring a default temporary path.................24
  115.         Using PAK with a WORM or Network Drive...............24
  116.         Configuring a standard archive title.................24
  117.    Appendices................................................25
  118.         Release History......................................25
  119.         Technical Notes......................................27
  120.              File Formats....................................27
  121.              Error Codes.....................................28
  122.         Credits..............................................28
  123.         Order Form...........................................29
  124.    PAK 2.51 (C) 1989-90 NoGate Consulting       October 8th, 1990  Page 1
  125.  
  126.  
  127.  
  128.    Introduction
  129.  
  130.    Purpose of PAK
  131.  
  132.         PAK is a utility to create and maintain file archives in
  133.    compressed form.  There are several advantages to compressing files.
  134.    On a hard disk, most files are accessed infrequently.  Reducing the
  135.    size of these files allows more of them to remain on the hard disk,
  136.    where they are more accessible than on a floppy in a file cabinet, and
  137.    frees disk space for other use.
  138.         Backup is simpler, faster, and cheaper, since the files are
  139.    smaller and organized into related groups.
  140.         Most importantly, compressed files take less time to transmit via
  141.    modem, and time is money when the transmission is long distance, or to
  142.    a service such as CompuServe.  Even on local computer bulletin boards,
  143.    reduced transmission time is an advantage.
  144.  
  145.         PAK is intended as a replacement for ARC by System Enhancement
  146.    Associates and PKARC and PKZIP by Philip Katz.  While PAK is faster
  147.    than ARC, speed is not the emphasis, and PAK does not attempt to
  148.    compete with PKARC in this respect.  However, PAK produces archive
  149.    files that are consistently 50% to 90% of the size produced by either
  150.    ARC, PKARC, or PKZIP 0.9 and supports files created by any of these
  151.    programs.  While PKZIP 1.0 files are roughly comparable in size to PAK
  152.    files, PAK supports more archive formats and more features.
  153.         Finally, PAK is available in a full screen edition which is much
  154.    easier to use than ARC, PKARC, or PKZIP, and in a programmer's toolkit
  155.    for those who want data compression in their own programs.
  156.  
  157.  
  158.    Archive Files
  159.  
  160.         PAK creates and modifies archive files, which have the .PAK,
  161.    .ARC, or .ZIP extension.  An archive file may contain one, two, or any
  162.    number of compressed files.  Files in an archive retain all of the
  163.    information they had in the directory, such as name, size, and date.
  164.    In addition, each file in an archive has a calculated CRC number,
  165.    which assures the detection of damage after events such as file
  166.    transmission via modem.
  167.  
  168.  
  169.    A Note on the Interface
  170.  
  171.         This manual describes PAK's commands as they are initially
  172.    configured.  Using PAKINST and the provided example files STDCFG.TXT
  173.    and ALTCFG.TXT, you can easily add, change, or delete the commands and
  174.    options which PAK understands.  For example, if the 'A' command is too
  175.    cryptic for your taste, you can change it to 'Add' or 'Compress'.
  176.         The section on PAKINST describes how to change the interface.
  177.    PAK 2.51 (C) 1989-90 NoGate Consulting       October 8th, 1990  Page 2
  178.  
  179.  
  180.    The Shareware Concept
  181.  
  182.         PAK is distributed as shareware.
  183.         Shareware is commercial software distributed in an unconventional
  184.    manner.  Microcomputers copy information very easily.  Instead of
  185.    trying to frustrate this through copy protection, shareware takes
  186.    advantage of it to reach as many users as possible at the lowest cost.
  187.    Anyone may copy a shareware program and distribute it to whomever they
  188.    desire, provided they do not charge a fee or alter it.
  189.         Shareware isn't free.  Serious shareware is as polished as any
  190.    conventional commercial product, and represents just as much
  191.    programming effort.  If you use it regularly, the authors expect
  192.    compensation.
  193.         However, unlike conventional distribution, shareware allows you
  194.    to evaluate the product before you decide to purchase it.  The price
  195.    is often lower, as well, because there are no advertising, packaging,
  196.    or distribution costs.
  197.         It can only work with your support.  If you are still using a
  198.    shareware product after a couple of weeks, then it is obviously worth
  199.    something to you, and you should register it.
  200.  
  201.  
  202.    Registration and Benefits
  203.  
  204.         There are three editions of the compression routines in PAK
  205.    available.  The first is the command line edition, included in the
  206.    evaluation package (of which this file is a part) distributed as
  207.    shareware.  Registration of this edition is $15, and entitles you to a
  208.    disk with a copy of PAK registered in your name.
  209.         The second is the full screen edition, also known as PAKF.  PAKF
  210.    is a fully windowed program which displays archive contents and file
  211.    directories, and allows easy tagging of files to be compressed or
  212.    extracted.  Registration of this edition is $30, and entitles you to a
  213.    disk with both the full screen and command line editions.
  214.         The third, for programmers, is a library of data compression
  215.    routines suitable for inclusion in your own programs.  This toolkit
  216.    can be used in practically any application, since all compression is
  217.    done on buffers in memory, not on disk.  Programs created with the
  218.    toolkit do not require a royalty so long as they do not compete with
  219.    PAK.  For example, you can compress your own program's data, or
  220.    distribute your software in compressed form without royalty.  On the
  221.    other hand, a general-purpose archiving, installation, or backup
  222.    utility would require a special licensing agreement.
  223.         Registration of this edition is $75, and entitles you to a disk
  224.    with object files suitable for use with Turbo Pascal, Turbo C,
  225.    Microsoft C, or assembler.  The toolkit is usable with OS/2 and
  226.    Windows 3.0.  The toolkit disk also includes the other two editions of
  227.    PAK, as well as example programs in Pascal and C.
  228.         To register your copy of PAK, send in a completed copy of the
  229.    enclosed order form, call the NoGate BBS to order via questionnaire,
  230.    or call NoGate Consulting at (616)455-6270.
  231.    PAK 2.51 (C) 1989-90 NoGate Consulting       October 8th, 1990  Page 3
  232.  
  233.  
  234.    Obtaining Updates
  235.  
  236.         The fastest way for registered users to obtain an update of any
  237.    of the editions of PAK is to call our bulletin board at (616)455-5179.
  238.    The BBS has a 9600 baud US Robotics Dual Standard modem, so any modem
  239.    from 1200 to 9600 baud should work.
  240.         If you have never called the BBS before, you will have to start
  241.    as a new user, even if you are a registered PAK user.  This entails
  242.    choosing a password and leaving some information such as your phone
  243.    number and city.
  244.         If you are a registered user, you can download PAK, PAKF, and the
  245.    Toolkit through the Update Door.  Before you can do so, however, you
  246.    will have to leave a message to the Sysop asking for access to that
  247.    door.
  248.         If you don't have a modem, or don't want to call our BBS, you can
  249.    call for an update at (616)455-6270, FAX us at (616)455-8491, or send
  250.    us a letter.
  251.         Updates are free from the BBS, and $5.50 by mail within the
  252.    United States or $7 overseas.  Updates of the Toolkit from release 1.6
  253.    or earlier are $25.
  254.  
  255.  
  256.    Limitations
  257.  
  258.         PAK can handle at most 16,000 files at once, though this may also
  259.    be limited by available memory.
  260.  
  261.  
  262.    Other NoGate Products
  263.  
  264.         CONTOUR, a utility for creating contour maps from empirical data.
  265.    Quickly and accurately approximates the entire surface from relatively
  266.    few data points, and then draws lines at each elevation change.  Also
  267.    creates AutoCad .DXF files.  Primarily intended for surveyors, taking
  268.    a few minutes for a process that normally takes weeks, but useful to
  269.    anyone who wishes to plot three dimensional data.  CONTOUR is $150.
  270.  
  271.         NoGate consulting also provides custom solutions in a wide
  272.    variety of fields including databases, networking, simulations, and
  273.    telecommunications.  Inquire for further information.
  274.  
  275.    List of Files
  276.  
  277.         Your copy of PAK251.EXE should contain:
  278.  
  279.        READ.ME      - This list of files, and documentation revisions.
  280.        PAK.EXE      - PAK version 2.51
  281.        PAK.DOC      - This documentation file.
  282.        PAKINST.EXE  - PAK installation program.
  283.        ORDER.FRM    - Order form for registration.
  284.        UPDATE.FRM   - Form for updates and upgrades.
  285.        SITE.FRM     - Form for site licenses.
  286.        STDCFG.TXT   - Text file for standard configuration.
  287.        ALTCFG.TXT   - Text file for alternate configuration.
  288.    PAK 2.51 (C) 1989-90 NoGate Consulting       October 8th, 1990  Page 4
  289.  
  290.  
  291.  
  292.  
  293.    The Security Envelope
  294.  
  295.         PAK 2.51 is the official archive program for distributing files
  296.    through SDNet/Works!, the Shareware Distribution Network.  PAK will
  297.    automatically recognize files distributed by The SDN Project and
  298.    SDNet/Works! (sm).  The SDN Project and SDNet/Works! is a cooperation
  299.    of BBS Sysops and not-for-profit.
  300.         SDN distributed files have the .SDN extension and a Security
  301.    Envelope which protects them from viruses.  PAK will automatically
  302.    check the integrity of SDN files.  If the archive has been altered in
  303.    any way, PAK will alert you.  If the archive is untouched, PAK will
  304.    display a page of information about the author.
  305.         Shareware authors interested in this free distribution should
  306.    contact The SDN Project BBS at 203-634-0370, 1200-9600HST baud, 8-N-1.
  307.  
  308.  
  309.    Creating An Archive
  310.  
  311.    The Add Command
  312.  
  313.         To create an archive, type
  314.  
  315.         PAK a <archive name> <file name or file names>
  316.  
  317.         A is the Add command, and adding files to an archive will create
  318.    it if it doesn't exist.  If the extension is omitted, PAK will look
  319.    first for a file with the extension PAK and then for ARC, ZIP, or SDN.
  320.         For example, to add the file "FOO.DAT" to an archive named
  321.    "BAR.PAK" (which need not already exist), type
  322.  
  323.         PAK a bar foo.dat
  324.  
  325.         The wildcard characters ? and * are also permissible, as are
  326.    multiple file specifications.  For example, to add all of the files
  327.    ending in ".DAT" to the same archive, and all of the files named
  328.    "TURBO" with any extension, type
  329.  
  330.         PAK a bar *.dat turbo.*
  331.  
  332.         Specifying a subdirectory will add all of the files in that
  333.    subdirectory.  For example,
  334.  
  335.         PAK a bak \c\lib
  336.  
  337.         would add all of the files in the "\c\lib" directory to the
  338.    archive "BAK.PAK", provided that "\c\lib" was a subdirectory.  Of
  339.    course, if "\c\lib" were simply a file, it would be added like any
  340.    other file.
  341.  
  342.         If you omit the file name, PAK assumes you mean "*.*", or all of
  343.    the files in the directory.
  344.    PAK 2.51 (C) 1989-90 NoGate Consulting       October 8th, 1990  Page 5
  345.  
  346.  
  347.    The Move Command
  348.  
  349.         The Add command copies files to an archive, and leaves the
  350.    originals intact.  The Move command also copies files to an archive,
  351.    but deletes the originals when the operation is successfully
  352.    completed.  Using the Move command is very similar to the Add command.
  353.    To move a file or files, type
  354.  
  355.         PAK m <archive name> <file name or names>
  356.  
  357.    The Update Command
  358.  
  359.         If a file specified in an Add or Move command has the same name
  360.    as a file already in the archive, PAK will ask if you wish to replace
  361.    the old file.  The Update command behaves much as the Add command
  362.    does, except that it replaces existing archived files automatically if
  363.    they have an older date, and does not replace newer files.  To update
  364.    a file or files, type
  365.  
  366.         PAK u <archive name> <file name or names>
  367.  
  368.         For example, suppose NEW1.DAT and NEW2.DAT existed in the archive
  369.    "SAVE.PAK", that the copy of NEW1.DAT in the archive was older than
  370.    the one on the disk, and that NEW3.DAT existed on the disk but not in
  371.    the archive.  Then
  372.  
  373.         PAK u save new1.dat new2.dat new3.dat
  374.  
  375.         would add "NEW1.DAT" and "NEW3.DAT" to "SAVE.PAK".
  376.  
  377.    The Freshen Command
  378.  
  379.         The Freshen command is very similar to the Update command, except
  380.    that it only checks files which already exist in the archive.  To
  381.    freshen files in an archive, type
  382.  
  383.         PAK f <archive name> <file name or names>
  384.  
  385.         For example,
  386.  
  387.         PAK f total *.*
  388.  
  389.         would check every file in the archive "TOTAL.PAK" and freshen any
  390.    which were older than those on the disk.  Note that the "*.*" in the
  391.    above example is optional; if you omit the file list, PAK assumes you
  392.    intended all files in the directory.
  393.  
  394.    Archiving Subdirectories
  395.  
  396.         By including the /I (include subdirectories) option with any of
  397.    the above commands (Add, Move, Update, or Freshen), you can add files
  398.    from several directories at once.
  399.    PAK 2.51 (C) 1989-90 NoGate Consulting       October 8th, 1990  Page 6
  400.  
  401.  
  402.         For example, if you had these directories -
  403.  
  404.         \DOCUMENT
  405.         \DOCUMENT\BUSINESS
  406.         \DOCUMENT\BUSINESS\LETTERS
  407.  
  408.         the command:
  409.  
  410.         PAK a save \document\g*.* /I
  411.  
  412.         would add all files which began with the letter G in each of the
  413.    three directories.  Similarly,
  414.  
  415.         PAK a image a:\ /I
  416.  
  417.         would archive every file from drive A.
  418.  
  419.  
  420.    Extracting Files From An Archive
  421.  
  422.    The Extract Command
  423.  
  424.         To copy files from an existing archive to the disk, type
  425.  
  426.         PAK e <archive name> <file name or names>
  427.  
  428.         For example, to unpack all of the files from the archive
  429.    "GAME.PAK", type
  430.  
  431.         PAK e game
  432.  
  433.         Again, PAK assumes that you mean all of the files in the archive
  434.    if you omit the file names to be extracted.  If one of the files to be
  435.    extracted already exists, PAK will stop and ask if you intend to
  436.    replace the existing file.
  437.  
  438.         When using any command which does involve compression (i.e., the
  439.    Add, Move, Update and Freshen commands), you can use wildcards in
  440.    specifying the archive name.  For example,
  441.  
  442.         PAK e ch* *.doc
  443.  
  444.         would extract all of the files with the extension .DOC from all
  445.    of the archives starting with the letters CH.  As usual, PAK will
  446.    provide .PAK, .ARC, .ZIP, or .SDN if you omit the extension.
  447.  
  448.         Extracting files to one or more remote subdirectories is much
  449.    like adding them from other subdirectories.  For example,
  450.  
  451.         PAK e project \c\objects\*.obj \c\source\*.c
  452.  
  453.         would extract all of the files with the extension .OBJ to the
  454.    \C\OBJECTS directory, and all the files with the extension .C to the
  455.    \C\SOURCE directory.
  456.    PAK 2.51 (C) 1989-90 NoGate Consulting       October 8th, 1990  Page 7
  457.  
  458.  
  459.  
  460.    The Extract and Remove Command
  461.  
  462.         Sometimes you may wish to move files out of an archive rather
  463.    than simply copying them.  To do this, type
  464.  
  465.         PAK x <archive name> <file name or names>
  466.  
  467.         The X command is like the Extract command in all ways except that
  468.    it deletes the files from the archive after unpacking them.  If this
  469.    removes all of the files from the archive, leaving it empty, it also
  470.    deletes the archive.
  471.  
  472.    Extracting Files to the Screen or Printer
  473.  
  474.         You can also extract files to the standard output, which is
  475.    normally the screen.  To do so, type
  476.  
  477.         PAK p <archive name> <file name or names>
  478.  
  479.         If you add the /MORE option to this command, PAK will pause after
  480.    each screen of information.
  481.  
  482.         Anything sent to the standard output can be re-directed to a
  483.    file, some other programs, or to the printer.  For example,
  484.  
  485.         PAK p docs >prn:
  486.  
  487.         would extract all of the files from the archive DOCS and send
  488.    them to the printer.
  489.         For other uses of redirection, consult your DOS manual.
  490.  
  491.  
  492.    Extracting files to their original paths
  493.  
  494.         PAK 2.51 saves complete path information for each file in your
  495.    archives.  By adding the /PATH option to the extract command, you can
  496.    tell PAK to restore your files to their original directories.  For
  497.    example, if you saved a directory and its subdirectories with the Add
  498.    command, like so:
  499.  
  500.         PAK a saved \test /I
  501.  
  502.         then you could restore every file from the archive to its
  503.    original location by typing
  504.  
  505.         PAK e saved /path
  506.  
  507.         PAK will create any needed directories if they do not already
  508.    exist.
  509.    PAK 2.51 (C) 1989-90 NoGate Consulting       October 8th, 1990  Page 8
  510.  
  511.  
  512.    Managing Archives
  513.  
  514.    Listing Files
  515.  
  516.         Both the L and V commands display a list of files, the original
  517.    sizes, and the file dates, in much the same format as the MSDOS DIR
  518.    command.  In addition, they display the type of compression,
  519.    compression ratio, the compressed size, time, and CRC checksum.  If
  520.    you add the /MORE option to the list command, PAK will pause after
  521.    each screen of information.
  522.         There is no difference between the two commands.  Both L and V
  523.    are provided for the convenience of those used to PAK 1.0.
  524.  
  525.         There are 12 compression types, created variously by ARC, PKARC,
  526.    PKZIP, and PAK.  PAK can extract files compressed with any of these,
  527.    and compress new files with the Crunched, Squashed, Shrunk, Crushed,
  528.    Imploded, or Distilled types.
  529.  
  530.           --      No compression.  Used by ARC, PKARC, PAK.
  531.  
  532.         Packed    Repeated byte values replaced by codes. Used by ARC.
  533.  
  534.        Squeezed   Huffman encoding, used by ARC 5.20 and earlier.
  535.  
  536.        crunched   Lempel-Zev compression, used by ARC 4.5 and earlier.
  537.  
  538.        Crunched   Lempel-Zev compression, used by ARC 5.0 and later.
  539.  
  540.        Squashed   Lempel-Zev compression, used by PKARC.
  541.  
  542.        Crushed    Lempel-Zev compression, used by PAK.
  543.  
  544.        Distill    Huffman/Sliding Window, used by PAK 2.51.
  545.  
  546.        Shrunk     Lempel-Zev compression, used by PKZIP.
  547.  
  548.        Reduced    Sliding Window, used by PKZip 0.9
  549.  
  550.        imploded   Huffman/Sliding Window, PKZIP 1.0 and later.
  551.  
  552.        Imploded   Huffman/Sliding Window, PKZip 1.1 and later.
  553.  
  554.  
  555.         PAK uses the CRC checksum to verify that the file is intact.
  556.  
  557.  
  558.    Deleting Files
  559.  
  560.         Sometimes you may wish to remove files from an archive, either
  561.    because they were added accidently or because they are no longer
  562.    useful.  To delete files from an archive, type
  563.  
  564.         PAK d <archive name> <file name or names>
  565.    PAK 2.51 (C) 1989-90 NoGate Consulting       October 8th, 1990  Page 9
  566.  
  567.  
  568.         For example,
  569.  
  570.         PAK d junk *.tmp
  571.  
  572.         would delete all the files ending in the ".TMP" extension from
  573.    the archive "JUNK.PAK".
  574.  
  575.         PAK can ask for confirmation before deleting each file.  To
  576.    enable this option, type
  577.  
  578.         PAK d /WP <archive name> <file name or names>
  579.  
  580.  
  581.    Testing files
  582.  
  583.         Sometimes the integrity of an archive (or any other file) is
  584.    suspect, such as after transmission by modem or after physical disk
  585.    damage.  The Test command checks all the specified files to insure
  586.    that they are intact.
  587.  
  588.         For example, to test the archive "POKER.PAK" which you have just
  589.    downloaded from a BBS, type
  590.  
  591.         PAK t poker
  592.  
  593.         PAK can also test multiple archives this way:
  594.  
  595.         PAK t *.pak
  596.  
  597.         would test all of the archives ending in the .PAK extension.
  598.  
  599.         If, for some reason, you wish to test only some of the files, you
  600.    may specify a list of files, much as you can for any other command.
  601.    For example,
  602.  
  603.         PAK t *.pak *.doc
  604.  
  605.         will test only files ending in the .DOC extension.
  606.  
  607.    Adding Remarks to Archives
  608.  
  609.         PAK supports variable length remarks for each file in an archive,
  610.    and for the archive as a whole.  PAK 2.51 also supports extended
  611.    comments, such as multiline remarks or remarks with ANSI graphics.  To
  612.    add these special remarks to a file, type @[filename] when asked for a
  613.    remark instead of a normal line of text.
  614.  
  615.         For example, at this prompt:
  616.  
  617.         Archive remark?
  618.  
  619.         You could type
  620.  
  621.         Demonstration (C) 1989 Special Software
  622.    PAK 2.51 (C) 1989-90 NoGate Consulting      October 8th, 1990  Page 10
  623.  
  624.  
  625.  
  626.         Or you could type
  627.  
  628.         @banner.txt
  629.  
  630.         where banner.txt is a file with the logo you wish to display.
  631.  
  632.         Note: PAK automatically removes the ANSI sequence for keyboard
  633.    remapping from remarks.
  634.  
  635.    The /R (remark) option
  636.  
  637.         Adding the /R option to any other command (such as Add or List)
  638.    will enable remarks.  For example,
  639.  
  640.         PAK a /r saved *.pas
  641.  
  642.         will add all the files with the extension .PAS to the archive
  643.    SAVED, and ask for the remark for each new file.
  644.  
  645.         PAK l /r saved
  646.  
  647.         would then include those remarks with the list of files in the
  648.    archive.
  649.  
  650.    The /H (header remark) option
  651.  
  652.         Adding the /H option to any other command will enable the remark
  653.    at the head of an archive.  In all other ways it is like the /R
  654.    option.
  655.  
  656.    The Revise command
  657.  
  658.         Sometimes you may wish to change the remarks in an archive.
  659.    Typing
  660.  
  661.         PAK r saved *.doc
  662.  
  663.         will first display the archive remark, and then display the files
  664.    with the extension .DOC one at a time, and ask for the new remark for
  665.    each.  If you wish to keep the existing remark, simply press <enter>.
  666.  
  667.    The Header command
  668.  
  669.         The H (header) command is just like Revise, except that it only
  670.    changes the remark at the head of the archive, and not the remarks for
  671.    the files in the archive.
  672.  
  673.  
  674.    Converting archives for other programs
  675.  
  676.         PAK can read archives created by ARC, PKARC, PKZIP, and earlier
  677.    versions of PAK directly.  To save space, however, you may wish to
  678.    PAK 2.51 (C) 1989-90 NoGate Consulting      October 8th, 1990  Page 11
  679.  
  680.  
  681.    convert archives to the PAK 2.0 format.  The C command extracts files
  682.    from the archive and recompresses them.
  683.  
  684.         Example:
  685.         To convert all the files in BONZO.ARC, type:
  686.  
  687.         PAK c bonzo
  688.  
  689.         If you add the /REN (rename) option, PAK will automatically
  690.    rename any converted archives to .PAK.  For example, if you had a
  691.    directory full of ARC format files which you wished to convert, you
  692.    could type
  693.  
  694.         PAK c *.ARC /ren
  695.  
  696.         and all of the files would be changed to .PAK.
  697.  
  698.         It is also possible to convert files created with PAK so that
  699.    they will be compatible with ARC, PKARC or PAK 1.x, by adding the C,
  700.    S, or CR compression type modifier:
  701.  
  702.         PAK c /c bonzo
  703.  
  704.         converts bonzo (created with PAK, PKARC, or PAK) to compression
  705.    types compatible with ARC, PKARC, and PAK 1.x.
  706.  
  707.         PAK c /s bonzo
  708.         converts bonzo to compression types compatible with PKARC or
  709.    PAK 1.x.
  710.  
  711.         PAK c /cr bonzo
  712.  
  713.         converts bonzo to compression types compatible with PAK 1.x.
  714.  
  715.  
  716.    Converting to and from ZIP files
  717.  
  718.         ZIP files are a special case, since they are in a format
  719.    completely different from ARC and PAK files.  PAK automatically
  720.    renames the archive to .PAK or .ZIP if you change from one format to
  721.    the other.  Otherwise, converting ZIP archives is much like converting
  722.    any other kind of archive.
  723.         To convert a PAK or ARC format archive to ZIP, type
  724.  
  725.         PAK c bonzo /z
  726.  
  727.         Version 1.01 PKUNZIP had bugs in it.  PAK compensate for these
  728.    when creating a ZIP archive, but this may hurt compression on some
  729.    files.  If you want to create a file that PKUNZIP 1.01 can read, you
  730.    must include the BUGS option:
  731.  
  732.         PAK c bonzo /bugs
  733.  
  734.         BUGS implies the Z (Zip format) option.
  735.    PAK 2.51 (C) 1989-90 NoGate Consulting      October 8th, 1990  Page 12
  736.  
  737.  
  738.         If you want to create an archive that ZIP 0.9 will read, you must
  739.    force PAK to use Shrinking only with the ZS option, like so:
  740.  
  741.         PAK c bonzo /zs
  742.  
  743.  
  744.    Self-Extracting Archives
  745.  
  746.         PAK can create special EXE files which contain archived files and
  747.    can extract them without PAK.  PAK treats these files like any other
  748.    archive, and any and all PAK commands will work on them.  There is an
  749.    additional overhead of approximately 6.7K for these files.
  750.         There is no royalty required to distribute self-extracting
  751.    archives, and several vendors use them as a method of delivering
  752.    software in a compressed form.
  753.  
  754.  
  755.    Creating self-extracting archives
  756.  
  757.         To create a self-extracting archive from scratch, simply use the
  758.    A (Add) command as you would to create a normal archive, and include
  759.    the /EXE option.
  760.  
  761.         For example,
  762.  
  763.         PAK a demo /exe
  764.  
  765.         will create a new archive DEMO.EXE which contains all the files
  766.    in the current directory.
  767.  
  768.  
  769.    Using self-extracting archives
  770.  
  771.         To extract files from a self-extracting archive, simply type the
  772.    name of the EXE file, like so:
  773.  
  774.         DEMO
  775.  
  776.         Self-extracting archives created by PAK normally ask before
  777.    writing over a file if the file with the same name exists.  You can
  778.    disable this by adding the /W (write-over) option:
  779.  
  780.         DEMO /w
  781.  
  782.         A self-extracting archive will pause after an archive remark and
  783.    ask if it should continue.  You can use this to display an opening
  784.    banner detailing the contents of the archive, so you, or anyone else
  785.    extracting the archive, have a better idea if you want to continue.
  786.         If you want to disable this, add the /N (no pause) option:
  787.  
  788.         DEMO /n
  789.    PAK 2.51 (C) 1989-90 NoGate Consulting      October 8th, 1990  Page 13
  790.  
  791.  
  792.    Self-extracting to a path
  793.  
  794.         By specifying a path, you can determine a destination for the
  795.    extracted files.  For example,
  796.  
  797.         DEMO c:\project
  798.  
  799.         will deliver the files in the C:\PROJECT directory.  If the
  800.    directory does not exist, the self-extracting archive will attempt to
  801.    create it.
  802.  
  803.         You can extract files to their original directories if you
  804.    include the /P (path) option.  Suppose you created the original
  805.    archive in a directory called C:\PROJECTS\ALIEN, which had two
  806.    subdirectories called TILES and TERRAIN.  You might create the
  807.    original archive like this:
  808.  
  809.         PAK a /exe alien *.exe *.com *.dat tiles\*.pic terrain\*.*
  810.  
  811.         If you then typed:
  812.  
  813.         ALIEN c:\games\alien /p
  814.  
  815.         The files would extract to C:\GAMES\ALIEN, C:\GAMES\ALIEN\TILES,
  816.    and C:\GAMES\ALIEN\TERRAIN.  If any of these directories, including
  817.    GAMES, did not exist, then the self-extracting archive would create
  818.    them.
  819.  
  820.  
  821.    Converting to self-extracting archives
  822.  
  823.         You can convert existing archives to a self-extracting format
  824.    with the C (Convert) command, like so:
  825.  
  826.         PAK c sales /exe
  827.  
  828.         You can also convert self-extracting files to conventional
  829.    archives with the Convert command.  For example,
  830.  
  831.         PAK c sales.exe
  832.  
  833.         will remove the self-extracting code from sales.
  834.  
  835.         Self-extracting archives created by EXEMAKE (which was
  836.    distributed with PAK 1.0 to 1.61) which contain remarks will generate
  837.    errors when read by PAK 2.51.   PAK cannot read these remarks, but it
  838.    will read the files.
  839.  
  840.  
  841.    Options
  842.  
  843.         In addition to the commands, PAK supports a variety of options.
  844.    We've already mentioned a few in passing.
  845.    PAK 2.51 (C) 1989-90 NoGate Consulting      October 8th, 1990  Page 14
  846.  
  847.  
  848.         These options aren't necessary for the day-to-day use of PAK, but
  849.    occasionally you may wish to use them.  Normally, these options appear
  850.    immediately after the command, separated by slashes (/) or dashes (-).
  851.    For example:
  852.  
  853.         PAK a /opt1 /opt2 archive
  854.  
  855.         While this is the normal ordering, it's not required, and the
  856.    options can appear anywhere on the line, provided each starts with the
  857.    slash character or dash character.  For example,
  858.  
  859.         PAK a archive /opt1 file /opt2
  860.  
  861.         is also acceptable.
  862.  
  863.         Note: Options may no longer be jammed together as they were in
  864.    PAK 1.0.  This format was hard to read, and precluded certain
  865.    combinations of option names.
  866.  
  867.  
  868.    Crunch, Squash, and Crush (/C, /S, and /CR)
  869.  
  870.         Using the /C, /S or /CR option will force PAK to use Crunching,
  871.    Squashing, or Crushing when compressing files.  They are of primary
  872.    use with the Convert command, but they can also be used with Add,
  873.    Move, Update, and Freshen.
  874.  
  875.  
  876.    Use Zip format (/Z, /ZS, /BUGS)
  877.  
  878.         The /Z, /ZS, and /BUGS options tell PAK to create a ZIP format
  879.    archive.  /BUGS forces PAK to write a file which accommodates bugs in
  880.    PKUNZIP 1.01, which may hurt compression.  /ZS forces PAK to use only
  881.    Shrinking, so that PKUNZIP 0.9 can read the archive.
  882.         Like the /C, /S, and /CR options, these options can be used
  883.    either with the Convert command or with Add, Move, Update, or Freshen.
  884.  
  885.  
  886.    Encrypting Files (/G)
  887.  
  888.         You can encrypt your archives with a password.  Files can still
  889.    be listed in such archives, but they cannot be extracted without the
  890.    password.
  891.         To encrypt files, type
  892.  
  893.         PAK a /g=<password> <archive name> <file name or names>
  894.  
  895.         The 'g' option stands for Garble.  Passwords used with the Garble
  896.    command are converted to all uppercase.  For example, to encrypt the
  897.    file "SECRET.EXE" in the archive "DARK.PAK" with the password "DEEP",
  898.    type
  899.  
  900.         PAK a /g=DEEP dark secret.exe
  901.    PAK 2.51 (C) 1989-90 NoGate Consulting      October 8th, 1990  Page 15
  902.  
  903.  
  904.         To extract it later, type
  905.  
  906.         PAK e /g=DEEP dark secret.exe
  907.  
  908.         While these are the most common uses of Garble, Garble can also
  909.    be used with any of the other commands.  For example, testing the
  910.    example encrypted archive requires the use of the Garble command:
  911.  
  912.         PAK t /g=DEEP dark
  913.  
  914.  
  915.    Duplicate Files (/D)
  916.  
  917.         The /D (duplicate) option selects only those files which are both
  918.    inside the archive and outside the archive.  For example,
  919.  
  920.         PAK e /d saved *.doc
  921.  
  922.         would only extract those files with the .DOC extension which
  923.    matched existing files on the disk.  The Freshen command is another
  924.    example of the /D option - it only adds those files which already
  925.    exist in the archive.
  926.         While of most use with the Add and Extract commands, the
  927.    Duplicate option can be used with other commands, such as List.
  928.  
  929.  
  930.    Make EXE file (/EXE)
  931.  
  932.         Including the /EXE option with the Convert command or any
  933.    compression command (such as Add or Update) will create a self-
  934.    extracting archive.  See the section on self-extracting archives.
  935.  
  936.  
  937.    Print in Hex format (/HEX)
  938.  
  939.         Adding the /HEX option to the Print command will display the file
  940.    in a hexadecimal format.
  941.    PAK 2.51 (C) 1989-90 NoGate Consulting      October 8th, 1990  Page 16
  942.  
  943.  
  944.    Including subdirectories (/I)
  945.  
  946.         The /I option causes PAK to search subdirectories when adding
  947.    files to an archive.  For example, if you had these directories -
  948.  
  949.         \DOCUMENT
  950.         \DOCUMENT\BUSINESS
  951.         \DOCUMENT\BUSINESS\LETTERS
  952.  
  953.         the command:
  954.  
  955.         PAK a save \document\g*.* /I
  956.  
  957.         would add all files which began with the letter G in each of the
  958.    three directories.  Similarly,
  959.  
  960.         PAK a image a:\ /I
  961.  
  962.         would archive every file from drive A.
  963.  
  964.         The /I command automatically includes the /PATH command so that
  965.    adding files to an existing archive will take the paths of the
  966.    original files into account.  You can change this by altering the
  967.    configuration file (STDCFG.TXT) and installing your new configuration
  968.    with PAKINST.  See the section on PAKINST.
  969.  
  970.  
  971.    Use last date (/L)
  972.  
  973.         Normally, the date of an archive is the last date it was altered
  974.    in any way.  If you add the /L option to any command which changes an
  975.    archive, the archive date will be set to that of the most recent file
  976.    in the archive.
  977.  
  978.  
  979.    Moving Files (/M)
  980.  
  981.         The Move option will delete files after compressing them or
  982.    extracting them.  The M (move) and X (extract + delete) commands are
  983.    actually the Add and Extract commands with the Move option.
  984.         This option is primarily of use in combination with Update or
  985.    Freshen, which do not have matching Move commands.
  986.  
  987.  
  988.    Pause after each page (/MORE)
  989.  
  990.         The /MORE option causes the List or Print commands to pause after
  991.    each page of text displayed.
  992.    PAK 2.51 (C) 1989-90 NoGate Consulting      October 8th, 1990  Page 17
  993.  
  994.  
  995.    Using the original path (/PATH)
  996.  
  997.         PAK stores the full path of each file compressed except for the
  998.    drive.  By including the /PATH option with most commands, you can take
  999.    this information into account.
  1000.         The List command displays the path of the archived files if you
  1001.    include the /PATH option.
  1002.         Compression commands (such as Add or Update) normally only
  1003.    consider the names of files when comparing old files in the archive to
  1004.    new files to be added.  For example, if there is a file in the archive
  1005.    named READ.ME, adding a new file named READ.ME will replace the old
  1006.    one.
  1007.         With the /PATH option, compression commands also consider the
  1008.    path.  In the previous example, if the first READ.ME was archived from
  1009.    the \123 directory, and the second was archived from the \TP5
  1010.    directory, they would be considered different files with the /PATH
  1011.    option.
  1012.  
  1013.  
  1014.    Use Remarks (/R and /H)
  1015.  
  1016.         Adding the /R option to any other command (such as Add or List)
  1017.    will enable remarks.  For example,
  1018.  
  1019.         PAK a /r saved *.pas
  1020.  
  1021.         will add all the files with the extension .PAS to the archive
  1022.    SAVED, and ask for the remark for each new file.
  1023.  
  1024.         PAK l /r saved
  1025.  
  1026.         would then include those remarks with the list of files in the
  1027.    archive.
  1028.  
  1029.         The /H option is similar, except that it only enables the remark
  1030.    at the head of an archive.
  1031.  
  1032.  
  1033.    Rename archives on convert (/REN)
  1034.  
  1035.         Adding this option to the Convert command will change the
  1036.    extensions of the converted archives to .PAK.
  1037.    PAK 2.51 (C) 1989-90 NoGate Consulting      October 8th, 1990  Page 18
  1038.  
  1039.  
  1040.    Sorting Files (/S)
  1041.  
  1042.         PAK supports sorting of archives by filename + extension (the
  1043.    normal method, used in release 1.0), extension + filename, date +
  1044.    time, size, or no sort at all.  To enable a sorting method, include
  1045.    one of these options:
  1046.  
  1047.         /SN  for filename + extension
  1048.         /SE  for extension + filename
  1049.         /ST  for date + time
  1050.         /SS  for size
  1051.         /NS  for no sort
  1052.  
  1053.         For example,
  1054.  
  1055.         PAK a /ST newmail mail*.*
  1056.  
  1057.         will add the all files starting with MAIL to the archive NEWMAIL
  1058.    in the order of the date and time of the files.  On the other hand,
  1059.  
  1060.         PAK l /SS saved
  1061.  
  1062.         would list all of the files in an archive in the order of their
  1063.    fully-expanded size, regardless of the actual order in SAVED.
  1064.  
  1065.         Note that adding any file to an archive will result in PAK
  1066.    sorting the archive.  In the first example above, all of the files in
  1067.    the archive NEWMAIL would be sorted by time, even if they were
  1068.    previously sorted by some other method.
  1069.  
  1070.         The standard sort for the compression commands (Add, Move,
  1071.    Update, Freshen) is by filename + extension.  For other commands, the
  1072.    standard is no sorting.
  1073.  
  1074.  
  1075.    Pack Archives (/P)
  1076.  
  1077.         Archives rarely compress, so normally PAK does not attempt to do
  1078.    so, which saves time.  Adding this option will force PAK to try and
  1079.    compress archive files.
  1080.  
  1081.  
  1082.    Check security envelope (/SEC)
  1083.  
  1084.         Adding the /SEC option to any command will check the security
  1085.    envelope for the archive before any other action.
  1086.  
  1087.  
  1088.    Only use Distill or Implode (/O)
  1089.  
  1090.         PAK normally uses Crushing on files of less than 1500 bytes when
  1091.    using Distilling, and if PAK is writing a ZIP file, PAK normally uses
  1092.    Shrinking on files of less than 500 bytes.  Using the /O option will
  1093.    force PAK to use only Distilling or Imploding.
  1094.    PAK 2.51 (C) 1989-90 NoGate Consulting      October 8th, 1990  Page 19
  1095.  
  1096.  
  1097.  
  1098.  
  1099.    The Temporary Path (/T)
  1100.  
  1101.         You can specify a path for temporary files, like so:
  1102.  
  1103.         PAK c /t=C: doodle
  1104.  
  1105.         Whenever PAK makes any change (adding or deleting a file) to an
  1106.    archive, PAK must create a temporary file for the changed archive.  If
  1107.    you are working on floppy disks, this limits the maximum size of an
  1108.    archive to half the volume of the disk, since the old copy and the new
  1109.    copy must exist at the same time.  If you use this option to specify a
  1110.    temporary path (such as C:), and you are working on drive A: or B:,
  1111.    PAK will create this temporary file in the Temporary Path and copy it
  1112.    over the old file when everything is done.  This allows archives up to
  1113.    the full size of a floppy.
  1114.         PAK also needs a temporary file if you Print or Convert a file
  1115.    which is larger than what PAK can hold in memory (this is always
  1116.    limited to 64K, even if you have more).  PAK will always try to use
  1117.    the Temporary Path to create this file.
  1118.         The temporary path can also be specified in the configuration
  1119.    information.  You can also specify in the configuration information
  1120.    which drives should always use the temporary path.  By default this is
  1121.    A and B.  The details of changing your configuration are described in
  1122.    the section on PAKINST (page 24).
  1123.         If the Temporary Path is invalid, PAK will use the directory of
  1124.    the archive instead.
  1125.  
  1126.  
  1127.    Replacing Existing Files (/W)
  1128.  
  1129.         Normally, PAK asks before replacing an existing file, either in
  1130.    an archive or on your disk.  You can change this by adding one of
  1131.    these options:
  1132.  
  1133.         /WA  Always replace existing files.
  1134.         /WP  Prompt before replacing existing files (normal).
  1135.         /WO  Replace older files.
  1136.         /WN  Never replace existing files.
  1137.  
  1138.         NOTE: The /WP option simply means 'Prompt' when used with the
  1139.    Delete command.  Also, the Update and Freshen commands automatically
  1140.    include the /WO option.
  1141.    PAK 2.51 (C) 1989-90 NoGate Consulting      October 8th, 1990  Page 20
  1142.  
  1143.  
  1144.    General Syntax
  1145.  
  1146.    The command format for PAK is:
  1147.  
  1148.      PAK <command> [/opt, /opt...] <arcname> [<filename>, <filename> ...]
  1149.                    [@<filename>]
  1150.  
  1151.         <command> is a command.
  1152.  
  1153.         [/opt] is zero or more options.
  1154.  
  1155.         <arcname> is the name of the archive to operate on, which may
  1156.    include the "wildcard" characters * or ?, provided <command> is not
  1157.    one of the compression commands (Add, Move, Update, or Freshen).
  1158.  
  1159.         <filename> is one or more file names.  Filenames may include the
  1160.    "wildcard" characters * and ?.  If you specify a directory or a disk
  1161.    drive, PAK will use all files in that directory.  If you don't list
  1162.    any files or directories, PAK assumes you mean all the files in the
  1163.    current directory.
  1164.  
  1165.         @<filename> is a response file.  A response file is a text file
  1166.    with commands, options, and file names, just as they would appear on
  1167.    the command line.
  1168.  
  1169.         Simply typing PAK will print a short list of commands.
  1170.  
  1171.  
  1172.    Summary of Standard PAK Commands
  1173.  
  1174.    Commands:
  1175.  
  1176.     A  Add files to archive           M  Move files to archive
  1177.     U  Update archive files           F  Update duplicate files
  1178.     E  Extract files from archive     X  Move files from archive
  1179.     D  Delete files                   L  List files
  1180.     V  List files                     P  Display files
  1181.     T  Test files                     C  Convert files
  1182.     R  Revise remarks                 H  Revise archive header
  1183.  
  1184.    Options:
  1185.  
  1186.         /sec  = check security envelope (if present)
  1187.         /m    = move files
  1188.         /c    = make ARC compatible files (Crunched).
  1189.         /s    = make PKARC compatible files (Squashed).
  1190.         /cr   = make PAK 1.x compatible files (Crushed).
  1191.         /z    = make ZIP 1.10 compatible archive (Imploded).
  1192.         /bugs = make ZIP 1.01 compatible archive.
  1193.         /zs   = make ZIP 0.9 compatible archive (Shrunk).
  1194.         /g    = encrypt the file with a password.
  1195.         /t    = use temporary path
  1196.         /d    = use only duplicate files.
  1197.         /wa   = always replace existing files
  1198.    PAK 2.51 (C) 1989-90 NoGate Consulting      October 8th, 1990  Page 21
  1199.  
  1200.  
  1201.         /wp   = prompt before replacing existing files (normal)
  1202.         /wo   = replace older files
  1203.         /wn   = never replace existing files
  1204.         /r    = use remarks
  1205.         /sn   = filename + extension order
  1206.         /se   = extension + filename order
  1207.         /st   = time order
  1208.         /ss   = size order
  1209.         /ns   = no order
  1210.         /p    = pack archives
  1211.         /l    = use last date in archive to stamp archive
  1212.         /hex  = display using hexadecimal format
  1213.         /more = pause after every page
  1214.         /ren  = rename archive extension to PAK when converting
  1215.         /path = use path to compress, extract, or display.
  1216.         /i    = include subdirectories
  1217.         /exe  = create self-extracting file
  1218.         /o    = Use only Distilling or Imploding.
  1219.  
  1220.    PAKINST (PAK install program)
  1221.  
  1222.         PAKINST can alter the interface for PAK to suit your needs.
  1223.    Also, if you are using a version of MSDOS or PCDOS earlier than 3.0,
  1224.    you will need to use PAKINST to install PAK.EXE in a specific
  1225.    directory.
  1226.         The configuration information for PAK is stored in the EXE file.
  1227.    However, you can convert this information to a text file with PAKINST,
  1228.    or convert a properly formatted text file to new configuration
  1229.    information.  Included with PAK 2.51 are two example text-format
  1230.    configuration files, STDCFG.TXT and ALTCFG.TXT.  By creating your own
  1231.    configuration files with a word processor, or by altering the provided
  1232.    examples, you can customize PAK's commands.
  1233.         PAKINST must always be run in the same directory with PAK.  To
  1234.    run PAKINST, simply type
  1235.  
  1236.         PAKINST
  1237.  
  1238.         PAKINST provides four choices:
  1239.  
  1240.          set [D]irectory for pak.exe (required ONLY for DOS 2.xx)
  1241.    configure [P]AK from text file
  1242.       create [T]ext file from PAK.EXE configuration
  1243.              [Q]uit
  1244.  
  1245.         To set the directory for PAK, select D.  If you are using DOS
  1246.    version 3.0 or later, this option is unnecessary.
  1247.         To configure PAK from a properly-formatted text file, select P.
  1248.         To create a text file from the current configuration of PAK,
  1249.    select T.
  1250.    PAK 2.51 (C) 1989-90 NoGate Consulting      October 8th, 1990  Page 22
  1251.  
  1252.  
  1253.    Text Configuration Files
  1254.  
  1255.         If you examine STDCFG.TXT, or create a new text file with PAKINST
  1256.    from the configuration information in PAK, you will notice that there
  1257.    are four basic sections: the header comment, the command definitions,
  1258.    the option definitions, and the default temporary path.
  1259.         These sections may be arranged in any order, but for clarity they
  1260.    are grouped together.
  1261.  
  1262.    Comments
  1263.  
  1264.         Text configuration files may include comments.  PAKINST will
  1265.    ignore anything contained in curly braces {} or Pascal comment symbols
  1266.    (* *).  For example,
  1267.  
  1268.        { This is a comment. }
  1269.        (* So is this. *)
  1270.  
  1271.         Comments may appear anywhere on a line.
  1272.  
  1273.  
  1274.    Command Definitions
  1275.  
  1276.         A command definition in a text-format file looks like this:
  1277.  
  1278.         <command> = <PAK command> [+ <PAK options>], "<help definition>"
  1279.  
  1280.         The <command> is the command as it will be used with PAK, i.e.
  1281.    'A' or 'Add'.  Commands must start with a letter, and may contain no
  1282.    spaces, but may be may be any length.
  1283.  
  1284.    <PAK option>      Standard option      Alternate option (ALTCFG.TXT)
  1285.    ADD                   A                 Add
  1286.    CONVERT               C                 Convert
  1287.    DELETE                D                 Del
  1288.    EXTRACT               E                 Ext
  1289.    LIST                  L or V            List
  1290.    REVISE                R                 Revise
  1291.    VIEW                  P                 View
  1292.    TEST                  T                 Test
  1293.  
  1294.       The command may also include one or more <PAK options>, separated
  1295.    by the plus (+) symbol.
  1296.  
  1297.    <PAK option>      Standard option      Alternate option (ALTCFG.TXT)
  1298.    ALWAYS_REPLACE        WA                Always
  1299.    ARCHIVE_REMARK        H                 Title
  1300.    ASCII                 (not used)        (not used)
  1301.    CRUNCH                C                 Crunch
  1302.    CRUSH                 CR                Crush
  1303.    DISTILL               (not used)        Distill
  1304.    DUPLICATE             D                 Dup
  1305.    PAK 2.51 (C) 1989-90 NoGate Consulting      October 8th, 1990  Page 23
  1306.  
  1307.  
  1308.    EARLY_ZIP             BUGS              Bugs
  1309.    EXT_SORT              SE                SExt
  1310.    HEX                   HEX               Hex
  1311.    IMPLODE               Z                 Zip
  1312.    INCLUDE_DIRS          I                 Include
  1313.    LAST_DATE             L                 Last
  1314.    MOVE                  M                 Move
  1315.    NAME_SORT             SN                SName
  1316.    NEVER_REPLACE         WN                Never
  1317.    NO_SORT               NS                SNone
  1318.    PACK_ARCHIVES         P                 Pack
  1319.    PASSWORD              G                 Pass
  1320.    PAUSE                 MORE              More
  1321.    PROMPT_REPLACE        WP                Prompt
  1322.    REMARK                R                 Rem
  1323.    RENAME                REN               Rename
  1324.    REPLACE_OLDER         WO                Older
  1325.    SELF_EXTRACT          EXE               EXE
  1326.    SHRINK                ZS                Shrink
  1327.    SINGLE                O                 (not used)
  1328.    SIZE_SORT             SS                SSize
  1329.    SQUASH                S                 Squash
  1330.    TEMP_PATH             T                 Temp
  1331.    TEST_ENVELOPE         SEC               Security
  1332.    TIME_SORT             ST                STime
  1333.    USE_PATH              PATH              Path
  1334.  
  1335.         Finally, separated from the commands and options by a comma and
  1336.    enclosed in quotation marks is the help definition for this command.
  1337.    The PAK help screen, obtained by typing PAK by itself, will display
  1338.    the text within these quotation marks after the command.
  1339.  
  1340.         For example, the Freshen command (F) in the STDCFG.TXT file looks
  1341.    like this:
  1342.  
  1343.        F = Add + Duplicate + Replace_Older + Name_Sort,
  1344.            "Update duplicate files"
  1345.  
  1346.         Reading this literally, PAKINST takes this as 'F means add files
  1347.    to the archive, selecting only duplicate files, replacing older files,
  1348.    and sorting by name.  When asked for help, display F followed by the
  1349.    text "Update duplicate files".'
  1350.         Notice that this does not all have to be on the same line.
  1351.  
  1352.    Option Definitions
  1353.  
  1354.         An option definition looks like this:
  1355.  
  1356.         /<option> = <PAK option> [+ <PAK options>], "<help definition>"
  1357.  
  1358.         This is much like a command definition, only it begins with a
  1359.    slash (/) to indicate it is an option.  Options, of course, may not
  1360.    include PAK commands.
  1361.    PAK 2.51 (C) 1989-90 NoGate Consulting      October 8th, 1990  Page 24
  1362.  
  1363.  
  1364.         For example,
  1365.  
  1366.         /MORE = PAUSE, "Pause after each page"
  1367.  
  1368.         indicates that the /MORE option means that PAK should PAUSE.
  1369.         If you have a set of options that you often use together, it may
  1370.    be worthwhile to create a new option or change an existing one.  For
  1371.    example,
  1372.  
  1373.         /MAIL = NO_SORT + ALWAYS_REPLACE + LAST_DATE + INCLUDE_DIRS
  1374.                 + USE_PATH, "Mail packet option"
  1375.  
  1376.  
  1377.    Configuring a default temporary path
  1378.  
  1379.         To specify a default temporary path, include a line in the text
  1380.    configuration file in this format:
  1381.  
  1382.         $TPATH = "<path>"
  1383.  
  1384.         For example,
  1385.  
  1386.         $TPATH = "C:"
  1387.  
  1388.         Will set the temporary path to drive C.
  1389.  
  1390.  
  1391.    Using PAK with a WORM or Network Drive
  1392.  
  1393.         Normally, PAK only uses the temporary path for intermediate files
  1394.    needed for Distilling and Imploding.  However, if you are working on a
  1395.    network drive or a WORM drive, you may want PAK to use the temporary
  1396.    path for everything but the finished archive.  In that case, you can
  1397.    set the $TDRIVES variable to specify these drives,
  1398.    like so:
  1399.  
  1400.         $TDRIVES = "A,B,E,H"
  1401.  
  1402.         In which case PAK would avoid writing to A:, B:, E:, or H: except
  1403.    when writing the finished archive.  By default, $TDRIVES is A: and B:.
  1404.  
  1405.  
  1406.    Configuring a standard archive title
  1407.  
  1408.         To specify a standard title to include in all of the archives
  1409.    which you create, include a line in the text configuration file in
  1410.    this format:
  1411.  
  1412.         $STD_TITLE = "<remark>"
  1413.  
  1414.         For example,
  1415.  
  1416.         $STD_TITLE = "Joe's BBS"
  1417.    PAK 2.51 (C) 1989-90 NoGate Consulting      October 8th, 1990  Page 25
  1418.  
  1419.  
  1420.         Will include the remark "Joe's BBS" in every archive you create
  1421.    with the /H option.  Like any other remark, the standard title can be
  1422.    the name of a file instead, like so:
  1423.  
  1424.         $STD_TITLE = "@C:\DOC\Title.txt"
  1425.  
  1426.         It's fairly important to include a complete path to a standard
  1427.    title file, since you could be using PAK in any path on any drive.
  1428.  
  1429.  
  1430.    Appendices
  1431.  
  1432.  
  1433.    Release History
  1434.  
  1435.         Release 2.51 (October 8th, 1990):
  1436.  
  1437.         Fixed bug with self-extracting archives with 7 or 8 character
  1438.    file names.
  1439.  
  1440.         Release 2.50 (September 20th, 1990):
  1441.  
  1442.         Added support for ZIP files.
  1443.         Added Temp path support for Network and WORM drives.
  1444.         Added Distill-only option.
  1445.         Added autochecking for security envelopes.
  1446.         Added error count display to test command.
  1447.         Added path support to self-extracting archives.
  1448.         Added pause feature to self-extracting archives.
  1449.         Reduced overhead for self-extracting archives.
  1450.         Fixed bug with deleting files from self-extracting archives.
  1451.  
  1452.         Release 2.10 (August 10th, 1989):
  1453.  
  1454.         Fixed bug with deleting files from multiple archives.
  1455.         Fixed bug which required excessive memory.
  1456.         Fixed another minor bug in Distill.
  1457.         Fixed bug with Garble and Distill.
  1458.         Added path-matching on compression.
  1459.         Added default archive title to configuration.
  1460.         Changed Revise command so as to preserve the security envelope.
  1461.  
  1462.         Release 2.01 (July 31st, 1989):
  1463.  
  1464.         Fixed minor bug in Distill.
  1465.  
  1466.         Release 2.0 (July 26th, 1989):
  1467.  
  1468.         Added Distill compression.
  1469.         Added security envelope.
  1470.         Added path support and subdirectory inclusion.
  1471.         Added ability to use all commands on self-extracting archives.
  1472.         Moved creation of self-extracting archives from EXEMAKE to PAK.
  1473.         Added write-over option for self-extracting archives.
  1474.    PAK 2.51 (C) 1989-90 NoGate Consulting      October 8th, 1990  Page 26
  1475.  
  1476.  
  1477.         Added pause feature.
  1478.         Added response file.
  1479.         Added option to rename converted archives to .PAK.
  1480.         Added summary for multiple archive conversion.
  1481.         Added default temp path to configuration information.
  1482.         Added filter to eliminate ANSI keyboard definition codes from
  1483.    remarks.
  1484.         Increased speed of Print option.
  1485.         Eliminated PAK.CNF.
  1486.         Eliminated need to install PAK for DOS version 3.0 and later.
  1487.         Eliminated restriction on foreign characters in file names.
  1488.         Eliminated difficulties with read-only files.
  1489.         Changed command syntax slightly to allow more flexibility in
  1490.    choice of command and option names.
  1491.         Allows use of '-' for options as well as '/'.
  1492.  
  1493.  
  1494.         Release 1.6 (January 24th, 1989):
  1495.  
  1496.    Fixed several small bugs.
  1497.         Added separate support for archive remarks.
  1498.         Added optional prompting on deletion.
  1499.         Changed Convert command to preserve archive date.
  1500.         Added optional date stamping using last date in archive.
  1501.         Fixed incorrect stack size in EXEMAKE which caused erratic
  1502.    failures.
  1503.         Added support for remarks in self-extracting archives.  Overhead
  1504.    increased to 6744 bytes.
  1505.  
  1506.         Release 1.51 (January 15th, 1989):
  1507.  
  1508.         Fixed bug which left junk bytes at the end of archives when using
  1509.    a simple Store on large files.  (Rare, usually only with already
  1510.    compressed files).
  1511.         Fixed bug in EXEMAKE with extraction of files over 64K.
  1512.         EXEMAKE fixes increase self-extraction overhead to 6674 bytes.
  1513.  
  1514.  
  1515.         Release 1.5 (January 12th, 1989):
  1516.  
  1517.         Added remarks.
  1518.         Added support for wildcards in specifying archives.
  1519.         Added extraction to standard output.
  1520.         Added sorting options.
  1521.         Added temporary path.
  1522.         Added configurable interface.
  1523.         Added target directory parameter to self-extracting archives.
  1524.         Improved error reporting.
  1525.         Reduced size overhead for self-extracting archives to 6662 bytes.
  1526.         Fixed bug in the Move command.
  1527.         Fixed problem with handling large numbers of files.
  1528.         Fixed bug with EXEMAKE forcing the name of the output .EXE to
  1529.    that of the input archive.
  1530.    PAK 2.51 (C) 1989-90 NoGate Consulting      October 8th, 1990  Page 27
  1531.  
  1532.  
  1533.         PAK Release 1.0 (October 17th, 1988):
  1534.  
  1535.         Initial release as PAK.
  1536.  
  1537.         GSARC Release 1.0 (October 13th, 1988):
  1538.  
  1539.         Limited release.
  1540.  
  1541.  
  1542.    Technical Notes
  1543.  
  1544.    File Formats
  1545.  
  1546.  
  1547.         In the interest of simplifying the creation of utilities by
  1548.    third-party developers, this section provides a short description of
  1549.    the file format for archives created with PAK.  For information on the
  1550.    ZIP format, see the file APPNOTE.TXT supplied with PKWare's PKZIP
  1551.    program.
  1552.  
  1553.         In the basic format for archives, each archived file has a header
  1554.    which looks like this:
  1555.  
  1556.    Marker (1 byte)  - always 26 (^Z, the eof mark for text files).
  1557.    Version (1 byte) - type of compression used.
  1558.    Name (13 bytes)  - an ASCIIZ string.
  1559.    Size (4 bytes)   - a long integer giving the current file size.
  1560.    Date (2 bytes)   - packed date.  bits 0-4  = day  5-8 = month
  1561.                                          9-15 = year - 1980.
  1562.    Time (2 bytes)   - packed time.  bits 0-4  = second / 2  5-10 = minute
  1563.                                         11-15 = hour.
  1564.    CRC (2 bytes)    - the CRC checksum for the expanded file.
  1565.    Length (4 bytes) - original length of file.
  1566.  
  1567.         The version field currently has the following values:
  1568.  
  1569.         0  End of file.  File header is only 2 bytes long (26 and 0).
  1570.         1  No compression. File header lacks the Length field.
  1571.         2  No compression.
  1572.         3  Run-length encoding (RLE).
  1573.         4  Huffman squeezing.
  1574.         5  Fixed-length 12 bit LZW compression.
  1575.         6  As above, with RLE.
  1576.         7  As above, but with a different hashing scheme.
  1577.         8  Variable-length 9-12 bit LZW compression with RLE.
  1578.         9  Variable-length 9-13 bit LZW compression without RLE.
  1579.        10  Crushing.
  1580.        11  Distilling.
  1581.  
  1582.         Basic archives end with a short header, containing just the
  1583.    marker (26) and the end of file value (0).  PAK release 1.5 extended
  1584.    this format by adding information after this end of file marker.  Each
  1585.    extended record has the following header:
  1586.    PAK 2.51 (C) 1989-90 NoGate Consulting      October 8th, 1990  Page 28
  1587.  
  1588.  
  1589.    Marker (1 byte)  - always 254
  1590.    type (1 byte)    - type of record
  1591.    File (2 bytes)   - # of file in archive to which this record refers,
  1592.                       or 0 for the entire archive.
  1593.    length (4 bytes) - size of record
  1594.  
  1595.         Type      Meaning
  1596.           0  End of file
  1597.           1  Remark
  1598.           2  Path
  1599.           3  Security envelope
  1600.           4  Error correction codes (not implemented in PAK 2.xx)
  1601.  
  1602.    Error Codes
  1603.  
  1604.         On exiting, PAK sets the DOS error level two one of four values:
  1605.  
  1606.         0    No Error
  1607.         1    CRC error in file or file missing
  1608.         2    Out of memory
  1609.         7    Disk error
  1610.  
  1611.    Credits
  1612.  
  1613.         ARC is a registered trademark of System Enhancement Associates,
  1614.    and PKZIP is a registered trademark of PKWare, Inc.  NoGate Consulting
  1615.    is not associated in any way with System Enhancement Associates or
  1616.    PKWare.
  1617.  
  1618.         We would like to thank several people:
  1619.  
  1620.         The various authors of the public-domain De-Arc'ing utility, for
  1621.    providing insights into the (sometimes very strange) internal workings
  1622.    of ARC:
  1623.  
  1624.         Roy Collins, David W. Carroll, Richard P. Byrne, Robert D. Tolz,
  1625.    and Jim North.
  1626.  
  1627.         We must also credit Terry A. Welch, whose article "A Technique
  1628.    for High Performance Data Compression", IEEE Computer Vol 17 No 6
  1629.    (June 1984) seems to have started all the research on Lempel-Zev
  1630.    coding.
  1631.  
  1632.         Spencer W. Thomas, Jim McKie, Steve Davies, Ken Turkowski, James
  1633.    A.  Woods, and Joe Orost, who are the authors of the UNIX compress
  1634.    utility.
  1635.  
  1636.         Ray Kaliss of SDNet/works!, who proposed the Security Envelope
  1637.    concept.
  1638.  
  1639.         And all of the people whose suggestions we added to PAK, such as
  1640.    the temporary path, sorting, wildcards for archives, path support, and
  1641.    remarks.
  1642.  
  1643.  
  1644.  
  1645.     PAK version 2.51                                       Order Form
  1646.       -----------------------------------------------------------------
  1647.         Make checks payable to:
  1648.           NoGate Consulting
  1649.           P.O. Box 88115
  1650.           Grand Rapids, MI 49518-0115
  1651.       -----------------------------------------------------------------
  1652.       Qty
  1653.       ___ Command line edition of PAK        @ $15 each         $______
  1654.       ___ Full screen edition of PAK (PAKF)  @ $30 each         $______
  1655.       ___ Programmer's edition of PAK        @ $75 each         $______
  1656.                                                    Subtotal     $______
  1657.           Michigan residents please add 4% sales tax.           $______
  1658.  
  1659.           Shipping and handling - inside the United States        $3.50
  1660.                                                                  - or -
  1661.                                 - overseas                        $5.00
  1662.  
  1663.           Credit Card orders add 3% surcharge                   $______
  1664.  
  1665.                                                         Total   $______
  1666.  
  1667.         Diskette type (check or circle one):   [ ] 5.25"  [ ] 3.5"
  1668.  
  1669.         Payment: (check or circle one):
  1670.         [ ] Check  [ ] Money Order  [ ] Visa  [ ] MasterCard [ ] AmEx
  1671.  
  1672.         Credit Card #__________________________________________________
  1673.  
  1674.         Expiration Date _______  Signature ____________________________
  1675.  
  1676.         Credit Card Orders may be made by phone - (616)455-6270
  1677.                           or via the NoGate BBS - (616)455-5179
  1678.                                      or via FAX - (616)455-8491
  1679.  
  1680.       Checks and Money Orders must be drawn on U.S. banks in U.S. funds
  1681.       -----------------------------------------------------------------
  1682.  
  1683.             Name_______________________________________________________
  1684.  
  1685.          Company_______________________________________________________
  1686.  
  1687.          Address_______________________________________________________
  1688.  
  1689.                 ______________________________________________________
  1690.  
  1691.            Phone_________________________  Bus.________________________
  1692.  
  1693.        Where did you obtain PAK?
  1694.  
  1695.                 _______________________________________________________
  1696.  
  1697.         Comments_______________________________________________________